Move code to /src

Question

Move code to /src

sadortun opened this issue 3 years ago · comments

Samuel Denis-D'Ortun commented 3 years ago

Hi!

What do you think about moving sources to /src folder ? I think it could make it more clear for new users what's config VS actual code ?

Have a nice day,
Samuel

Daniel · Answer 1 · Tue Aug 17 2021 10:45:48 GMT+0800 (China Standard Time)

I don't mind this suggestion, I think it could tidy up folder management. The current setup gives the impression that all these files are needed to create a Parse Server, when in reality it's only a few (which would be contained in /src.

I think that a lot of docs would need to updated inline with this change, just to make sure there's no confusion.

We are also working on a CLI version to generate an example Parse Server, so this way you only receive files that you need (for example, you would only receive ESLint files if you select ESLint in the CLI config)

Samuel Denis-D'Ortun · Answer 2 · Tue Aug 17 2021 11:41:13 GMT+0800 (China Standard Time)

Nice ! So should I open a PR with this first step or we wait for your CLI?

Daniel · Answer 3 · Tue Aug 17 2021 11:44:53 GMT+0800 (China Standard Time)

@mtrezza what are your thoughts?

Manuel · Answer 4 · Tue Aug 17 2021 19:03:59 GMT+0800 (China Standard Time)

Good idea, I think a /src folder is a common practice, and we also use it in the parse-server repo.

I assume that includes the index.js and contents of /cloud? We would have to look into the docs and readme whether changes are necessary, because the concept of /cloud/main.js has been around for years, so there may be references to it.

Samuel Denis-D'Ortun · Answer 5 · Tue Aug 17 2021 19:27:42 GMT+0800 (China Standard Time)

We would have to look into the docs and readme whether changes are necessary

The important would be to make sure to update links that points to theses files to avoid 404. But if we forget a few links that only mention /cloud , it's not a big deal.